package org.example.aienglishapp.mapper.login;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.RowBounds;
import org.example.aienglishapp.entity.login.User;
import org.springframework.stereotype.Repository;

import java.util.List;
import java.util.Optional;

/**
 * 用户映射接口。
 *
 * 该接口定义了与用户相关的数据库操作方法，并使用 MyBatis 进行持久层的交互。
 *
 * @author xlj
 * @since 2024-10-1
 * @version 1.0
 */
@Mapper
@Repository
public interface UserMapper {

    /**
     * 根据用户名查询用户信息。
     *
     * @param userName 用户名
     * @return 返回对应的用户对象，如果未找到则返回 null
     */
    User findByUserName(@Param("userName") String userName);

    /**
     * 根据用户状态查询用户列表。
     *
     * @param userStatus 用户状态
     * @return 返回一个包含指定状态用户的列表
     */
    List<User> findByUserStatus(@Param("userStatus") Integer userStatus);

    /**
     * 查询系统中所有的用户。
     *
     * @return 返回一个包含所有用户的列表
     */
    List<User> findAll();

    /**
     * 分页查询所有用户。
     *
     * @param rowBounds 分页参数
     * @return 返回分页后的用户列表
     */
    List<User> selectAll(@Param("rowBounds") RowBounds rowBounds);

    /**
     * 更新用户的状态。
     *
     * @param userId     用户ID
     * @param userStatus 新的状态值
     */
    void updateUserStatus(@Param("userId") Long userId, @Param("userStatus") Integer userStatus);

    /**
     * 检查指定的用户名是否存在。
     *
     * @param userName 用户名
     * @return 如果存在返回 true，否则返回 false
     */
    Boolean existsByUserName(@Param("userName") String userName);

    /**
     * 检查指定的角色ID是否有用户关联。
     *
     * @param roleId 角色ID
     * @return 如果有用户关联返回 true，否则返回 false
     */
    boolean hasUsersWithRole(@Param("roleId") Long roleId);

    /**
     * 插入新的用户记录。
     *
     * @param user 要插入的用户对象
     */
    void insert(User user);

    /**
     * 更新用户信息。
     *
     * @param user 要更新的用户对象
     */
    void update(User user);

    /**
     * 根据用户ID查询用户信息。
     *
     * @param userId 用户ID
     * @return 返回对应的用户对象，如果未找到则返回 Optional.empty()
     */
    Optional<User> findById(@Param("userId") Long userId);

    /**
     * 根据用户ID查询用户信息及其个人资料。
     *
     * @param userId 用户ID
     * @return 返回包含个人资料的用户对象，如果未找到则返回 Optional.empty()
     */
    Optional<User> findByIdWithProfile(@Param("userId") Long userId);

    /**
     * 根据用户ID删除用户。
     *
     * @param userId 用户ID
     */
    void deleteUserById(@Param("userId") Long userId);

    /**
     * 根据手机号码查询用户信息。
     *
     * @param phoneNumber 手机号码
     * @return 返回对应的用户对象，如果未找到则返回 null
     */
    User findByPhoneNumber(@Param("phoneNumber") String phoneNumber);

    /**
     * 检查指定的手机号码是否存在。
     *
     * @param phoneNumber 手机号码
     * @return 如果存在返回 true，否则返回 false
     */
    boolean existsByPhoneNumber(@Param("phoneNumber") String phoneNumber);

    /**
     * 检查指定的表是否存在于数据库中。
     *
     * @param tableName 表名称
     * @return 如果存在返回 true，否则返回 false
     */
    boolean checkTableExists(@Param("tableName") String tableName);
}